<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /* <a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009 Regents of the University of Colorado.  <a name="line.2"></a>
<FONT color="green">003</FONT>     All rights reserved. <a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>     Licensed under the Apache License, Version 2.0 (the "License"); <a name="line.5"></a>
<FONT color="green">006</FONT>     you may not use this file except in compliance with the License. <a name="line.6"></a>
<FONT color="green">007</FONT>     You may obtain a copy of the License at <a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>     http://www.apache.org/licenses/LICENSE-2.0 <a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     Unless required by applicable law or agreed to in writing, software <a name="line.11"></a>
<FONT color="green">012</FONT>     distributed under the License is distributed on an "AS IS" BASIS, <a name="line.12"></a>
<FONT color="green">013</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <a name="line.13"></a>
<FONT color="green">014</FONT>     See the License for the specific language governing permissions and <a name="line.14"></a>
<FONT color="green">015</FONT>     limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>    */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.uutuc.descriptor;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.lang.annotation.ElementType;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.lang.annotation.Retention;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.lang.annotation.RetentionPolicy;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.lang.annotation.Target;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    /**<a name="line.24"></a>
<FONT color="green">025</FONT>     * This annotation marks an analysis component member variable as a<a name="line.25"></a>
<FONT color="green">026</FONT>     * configuration parameter. The types of member variables that can use this<a name="line.26"></a>
<FONT color="green">027</FONT>     * annotation are:<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;ul&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;li&gt;String&lt;/li&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;li&gt;String[]&lt;/li&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;li&gt;Boolean&lt;/li&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;li&gt;boolean&lt;/li&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;li&gt;Boolean[]&lt;/li&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;li&gt;boolean[]&lt;/li&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;li&gt;Integer&lt;/li&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;li&gt;int&lt;/li&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;li&gt;Integer[]&lt;/li&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     * &lt;li&gt;int[]&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;li&gt;Float&lt;/li&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;li&gt;float&lt;/li&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;li&gt;Float[]&lt;/li&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;li&gt;float[]&lt;/li&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;/ul&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * <a name="line.44"></a>
<FONT color="green">045</FONT>     * Fields marked with this annotation should be declared public or have a setter<a name="line.45"></a>
<FONT color="green">046</FONT>     * method. The setter method should be named according to setter naming<a name="line.46"></a>
<FONT color="green">047</FONT>     * convention - e.g. a field named "myConfigurationParameter" should have a<a name="line.47"></a>
<FONT color="green">048</FONT>     * corresponding setter named "setMyConfigurationParameter" with a single<a name="line.48"></a>
<FONT color="green">049</FONT>     * parameter whose type is the same as the type of the field (i.e. you can not<a name="line.49"></a>
<FONT color="green">050</FONT>     * mix and match the object or primitive types here).<a name="line.50"></a>
<FONT color="green">051</FONT>     * <a name="line.51"></a>
<FONT color="green">052</FONT>     * @author Philip Ogren<a name="line.52"></a>
<FONT color="green">053</FONT>     * <a name="line.53"></a>
<FONT color="green">054</FONT>     */<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>    @Retention(RetentionPolicy.RUNTIME)<a name="line.56"></a>
<FONT color="green">057</FONT>    @Target(ElementType.FIELD)<a name="line.57"></a>
<FONT color="green">058</FONT>    public @interface ConfigurationParameter {<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>            String name();<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>            String description() default "";<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>            boolean mandatory() default false;<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>            /**<a name="line.66"></a>
<FONT color="green">067</FONT>             * What can be the value should correspond with the type of the field that<a name="line.67"></a>
<FONT color="green">068</FONT>             * is annotated. If for example, the field is a String, then the default<a name="line.68"></a>
<FONT color="green">069</FONT>             * value can be any string - e.g. "asdf". If the field is a boolean, then<a name="line.69"></a>
<FONT color="green">070</FONT>             * the default value can be "true" for true or any other string for false.<a name="line.70"></a>
<FONT color="green">071</FONT>             * If the field is an integer, then the default value can be any string that<a name="line.71"></a>
<FONT color="green">072</FONT>             * Integer.parseInt() can successfully parse. Remember that just because the<a name="line.72"></a>
<FONT color="green">073</FONT>             * default value is a string here that you should give an actual integer<a name="line.73"></a>
<FONT color="green">074</FONT>             * (not an integer parseable string) value when setting the parameter via<a name="line.74"></a>
<FONT color="green">075</FONT>             * e.g. AnalysisEngineFactory.createPrimitiveDescription(). If the field is<a name="line.75"></a>
<FONT color="green">076</FONT>             * an float, then the default value can be any string that<a name="line.76"></a>
<FONT color="green">077</FONT>             * Float.parseFloat() can successfully parse. Remember that just because the<a name="line.77"></a>
<FONT color="green">078</FONT>             * default value is a string here that you should give an actual float value<a name="line.78"></a>
<FONT color="green">079</FONT>             * (not a float parseable string) when setting the parameter via e.g.<a name="line.79"></a>
<FONT color="green">080</FONT>             * AnalysisEngineFactory.createPrimitiveDescription().<a name="line.80"></a>
<FONT color="green">081</FONT>             * &lt;p&gt;<a name="line.81"></a>
<FONT color="green">082</FONT>             * If the field is multiValued, then the value should look something like<a name="line.82"></a>
<FONT color="green">083</FONT>             * this '{"value1", "value2"}' <a name="line.83"></a>
<FONT color="green">084</FONT>             * &lt;p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>             * If you want a field to be initialized with a null value, then do not specify a default value or specify the value given by the field {@link #NO_DEFAULT_VALUE}<a name="line.85"></a>
<FONT color="green">086</FONT>             */<a name="line.86"></a>
<FONT color="green">087</FONT>            String[] defaultValue() default NO_DEFAULT_VALUE;<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>            public static final String TYPE_STRING = org.apache.uima.resource.metadata.ConfigurationParameter.TYPE_STRING;<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>            public static final String TYPE_BOOLEAN = org.apache.uima.resource.metadata.ConfigurationParameter.TYPE_BOOLEAN;<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>            public static final String TYPE_INTEGER = org.apache.uima.resource.metadata.ConfigurationParameter.TYPE_INTEGER;<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>            public static final String TYPE_FLOAT = org.apache.uima.resource.metadata.ConfigurationParameter.TYPE_FLOAT;<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>            public static final String NO_DEFAULT_VALUE = "org.uutuc.descriptor.ConfigurationParameter.NO_DEFAULT_VALUE";<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>    }<a name="line.99"></a>




























































</PRE>
</BODY>
</HTML>
